Report Object

A report corresponds to a print job in the Crystal Report Engine. When the report object is destroyed, or goes out of focus, it closes the print job. It holds on to Application Object. When a Report Object gets destroyed, it releases the application.

Access to the Report Object is dependent on the object variable you create. If the object variable goes out of scope, you will lose access to the Report Object and, therefore, the report. You may want to declare your Report Object variable as Global.

Report Object Properties

Property Description Read/ Write Restriction in
event handler

Application

Application Object. Gets reference to the Application Object that the Report Object is associated with.

Read only

None

Application
Name

String. Gets or sets the application name.

Read/Write

None

Areas

Areas Collection. Gets reference to the Areas Collection, a collection of all the areas in the report which can be indexed by a number or by a string, such as "RH", "GF1". The areas are in the same order as on the Crystal Reports Design Tab. For Example: RH, PH, GH1,...GHn, D, GFn,...GF1, RF, PF. The abbreviations for areas are case sensitive.

Read only

None

BottomMargin

Long. Gets or sets the page bottom margin, in twips.

Read/Write

Can be written only when formatting idle.

CanPerform
GroupingOn
Server

Boolean. Gets whether the report can perform grouping on the server.

Read only

None

CaseInsensitive
SQLData

Boolean. Gets or sets the report option that indicates whether the SQL data used in the report becomes case sensitive.

Read/Write

Can be written only when formatting idle.

ConvertDate
TimeType

CRConvertDateTimeType. Gets or sets the report option that specifies the format to be converted for date/time fields.

Read/Write

Can be written only when formatting idle.

ConvertNull
FieldToDefault

Boolean. Gets or sets the report option that indicates whether to convert any null values to the database field default.

Read/Write

Can be written only when formatting idle.

Database

Database Object. Gets reference to the Database Object which represents the database used in the report.

Read only

None

DisplayProgress
Dialog

Boolean. Enable or disable the progress dialog.

Read/Write

Can be written only when formatting idle.

DriverName

String. Gets the printer driver name used by the current report. Gets an empty string if default printer is used.

Read only

Can be written only when formatting idle.

EnableAsync
Query

Boolean. Gets or sets the enable AsyncQuery

Read/Write

Can be written only when formatting idle.

EnableGenerating
DataForHidden
Object

Boolean. Gets or sets the Enable Generating Data For Hidden Object option.

Read/Write

Can be written only when formatting idle.

EnableParameter
Prompting

Boolean. Gets or sets the prompting for parameter fields option.

Read/Write

Can be written only when formatting idle.

EnablePerform
Queries
Asynchronously

Boolean. Gets or sets the perform queries asynchronously option

Read/Write

Can be written only when formatting idle.

EnableSelect
DistinctRecords

Boolean. Gets or sets the select distinct records option

Read/Write

Can be written only when formatting idle.

ExportOptions

ExportOptions Object. Gets reference to ExportOptions Object for the report.

Read only

None

FieldMapping
Type

CRFieldMappingType. Gets or sets the field mapping type.

Read/Write

Can be written only when formatting idle.

FormulaFields

FormulaFieldDefinitions Collection. Gets reference to Collection of all the named FormulaFieldDefinitions defined in the Report.

Read only

None

FormulaSyntax

CRFormulaSyntax. Gets or sets report formula syntax.

Read/Write

Can be written only when formatting idle.

GroupName
Fields

GroupNameFieldDefinitions Collection. Gets reference to a collection of all the group name fields defined in the report.

Read only

None

GroupSelection
Formula

String. Gets or sets the group selection formula.

Read/Write

Can be written only when formatting idle.

GroupSortFields

SortFields Collection. Gets reference to group sort field collection.

Read only

None

HasSavedData

Boolean. Gets whether the report has data saved in memory.

Read only

None

KeywordsIn
Report

String. Gets or sets the keywords in the report.

Read/Write

Can be written only when formatting idle.

Kind

CRReportKind. Gets what kind of report.

Read only

None

LastGetFormula
Syntax

CRFormulaSyntax. Gets the formula syntax of the last formula text returned.

Read only

None

LeftMargin

Long. Gets or sets the page left margin, in twips.

Read/Write

Can be written only when formatting idle.

MorePrintEngine
ErrorMessages

Boolean. Gets or sets the report option that indicates whether to pop up database error dialogs during printing when a Report Engine error occurs.

Read/Write

Can be written only when formatting idle.

NumberOfGroup

Long. Gets the number of groups in the report.

Read only

None

PageEngine

PageEngine Object. Gets reference to the PageEngine object.

Read only

None

PaperOrientation

CRPaperOrientation. Gets or sets the current printer paper orientation. For the default printer, crDefaultPaperOrientation is returned.

Read/Write

Can be written only when formatting idle.

PaperSize

CRPaperSize. Gets or sets the current printer paper size. For the default printer, crDefaultPaperSize is returned.

Read/Write

Can be read or written only when formatting idle.

PaperSource

CRPaperSource. Gets or sets the current printer paper source.

Read/Write

Can be written only when formatting idle.

ParameterFields

ParameterFieldDefinitions Collection. Gets reference to the collection of all the ParameterFieldDefinitions defined in the report. This property will return parameter fields found in the main report as well as any subreports included in the report (for example, if the main report has 3 parameters and a subreport included within the report has an additional 2 parameters, the number of parameter fields in the collection returned by Report.ParameterFields would be 5).

Read only

None

Parent

Report Object. Gets reference to the parent object for subreports. (NULL for main report).

Read only

None

PerformGrouping
OnServer

Boolean. Gets or sets the performing grouping on server option.

Read/Write

Can be written only when formatting idle.

PortName

String. Gets the printer port name used by the current report. Gets an empty string if the default printer is used.

Read only

None

PrintDate

Date. Gets or sets the print date for the report. By default, the current date will be used.

Read/Write

Can be written only when formatting idle.

PrinterDuplex

CRPrinterDuplexType. Gets or sets the current printer duplex option.

Read/Write

Can be written only when formatting idle.

PrinterName

String. Gets the printer name used by the report. Gets an empty string if the default printer is used.

Read only

None

PrintingStatus

PrintingStatus Object. Gets PrintingStatus Object for the report.

Read only

None

RecordSelection
Formula

String. Gets or sets record selection formula.

Read/Write

Can be written only when formatting idle.

RecordSortFields

SortFields Collection. Gets a collection of record sort fields.

Read only

None

ReportAlerts

ReportAlerts Collection. Gets reference to Collection of all the named Report Alerts defined in the Report.

Read only

None

ReportAuthor

String. Gets or sets the report author.

Read/Write

Can be written only when formatting idle.

ReportComments

String. Gets or sets report comments.

Read/Write

Can be written only when formatting idle.

ReportSubject

String. Gets or sets the report subject.

Read/Write

Can be written only when formatting idle.

ReportTemplate

String. Gets or sets the report template.

Read/Write

Can be written only when formatting idle.

ReportTitle

String. Gets or sets the report title.

Read/Write

Can be written only when formatting idle.

RightMargin

Long. Gets or sets the page right margin, in twips.

Read/Write

Can be written only when formatting idle.

RunningTotal
Fields

RunningTotalFieldDefinitions Collection. Gets running total fields collection.

Read only

None

SavePreview
Picture

Boolean. Gets or sets save preview picture with report option.

Read/Write

None

Sections

Sections Collection. Gets collection of all the sections in the report.

Read only

None

SQLExpression
Fields

SQLExpressionFieldDefinitions Collection. Gets SQL expression field collection.

Read only

None

SQLQueryString

String. Gets or sets SQL query string.

Read/Write

Can be written only when formatting idle.

SummaryFields

SummaryFieldDefinitions Collection. Gets collection for group and report summaries (cross-tab summaries not available using this property).

Read only

None

TopMargin

Long. Gets or sets the page top margin, in twips.

Read/Write

Can be written only when formatting idle.

TranslateDos
Memos

Boolean. Gets or sets the report option that indicates whether to translate DOS memos.

Read/Write

Can be written only when formatting idle.

TranslateDos
Strings

Boolean. Gets or sets the report option that indicates whether to translate DOS strings.

Read/Write

Can be written only when formatting idle.

UseIndexFor
Speed

Boolean. Gets or sets the use index for speed during record selection report option.

Read/Write

Can be written only when formatting idle.

VerifyOnEvery
Print

Boolean. Gets or sets the report option that indicates whether to verify the database every time the report is printed.

Read/Write

Can be written only when formatting idle.



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com